home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / CIncludes / Aliases.h < prev    next >
C/C++ Source or Header  |  1996-05-01  |  6KB  |  165 lines
  1. /*
  2.      File:        Aliases.h
  3.  
  4.      Contains:    Alias Manager Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. */
  18. #ifndef __ALIASES__
  19. #define __ALIASES__
  20.  
  21. #ifndef __TYPES__
  22. #include <Types.h>
  23. #endif
  24. #ifndef __APPLETALK__
  25. #include <AppleTalk.h>
  26. #endif
  27. #ifndef __FILES__
  28. #include <Files.h>
  29. #endif
  30.  
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34.  
  35. #if PRAGMA_IMPORT_SUPPORTED
  36. #pragma import on
  37. #endif
  38.  
  39. #if PRAGMA_ALIGN_SUPPORTED
  40. #pragma options align=mac68k
  41. #endif
  42.  
  43. #if FOR_SYSTEM7_AND_SYSTEM8_COOPERATIVE
  44.  
  45. enum {
  46.     rAliasType                    = 'alis',                        /* Aliases are stored as resources of this type */
  47.                                                                 /* define alias resolution action rules mask */
  48.     kARMMountVol                = 0x00000001,                    /* mount the volume automatically */
  49.     kARMNoUI                    = 0x00000002,                    /* no user interface allowed during resolution */
  50.     kARMMultVols                = 0x00000008,                    /* search on multiple volumes */
  51.     kARMSearch                    = 0x00000100,                    /* search quickly */
  52.     kARMSearchMore                = 0x00000200,                    /* search further */
  53.     kARMSearchRelFirst            = 0x00000400,                    /* search target on a relative path first */
  54.                                                                 /* define alias record information types */
  55.     asiZoneName                    = -3,                            /* get zone name */
  56.     asiServerName                = -2,                            /* get server name */
  57.     asiVolumeName                = -1,                            /* get volume name */
  58.     asiAliasName                = 0,                            /* get aliased file/folder/volume name */
  59.     asiParentName                = 1                                /* get parent folder name */
  60. };
  61.  
  62. /* define the alias record that will be the blackbox for the caller */
  63. struct AliasRecord {
  64.     OSType                             userType;                    /* appl stored type like creator type */
  65.     unsigned short                     aliasSize;                    /* alias record size in bytes, for appl usage */
  66. };
  67. typedef struct AliasRecord AliasRecord;
  68.  
  69. typedef AliasRecord *AliasPtr;
  70. typedef AliasPtr *AliasHandle;
  71. /* alias record information type */
  72. typedef short AliasInfoType;
  73. /*  create a new alias between fromFile-target and return alias record handle  */
  74. extern pascal OSErr NewAlias(ConstFSSpecPtr fromFile, const FSSpec *target, AliasHandle *alias)
  75.  TWOWORDINLINE(0x7002, 0xA823);
  76.  
  77. /* create a minimal new alias for a target and return alias record handle */
  78. extern pascal OSErr NewAliasMinimal(const FSSpec *target, AliasHandle *alias)
  79.  TWOWORDINLINE(0x7008, 0xA823);
  80.  
  81. /* create a minimal new alias from a target fullpath (optional zone and server name) and return alias record handle  */
  82. extern pascal OSErr NewAliasMinimalFromFullPath(short fullPathLength, const void *fullPath, ConstStr32Param zoneName, ConstStr31Param serverName, AliasHandle *alias)
  83.  TWOWORDINLINE(0x7009, 0xA823);
  84.  
  85. /* given an alias handle and fromFile, resolve the alias, update the alias record and return aliased filename and wasChanged flag. */
  86. extern pascal OSErr ResolveAlias(ConstFSSpecPtr fromFile, AliasHandle alias, FSSpec *target, Boolean *wasChanged)
  87.  TWOWORDINLINE(0x7003, 0xA823);
  88.  
  89. /* given an alias handle and an index specifying requested alias information type, return the information from alias record as a string. */
  90. extern pascal OSErr GetAliasInfo(AliasHandle alias, AliasInfoType index, Str63 theString)
  91.  TWOWORDINLINE(0x7007, 0xA823);
  92.  
  93. /*
  94.   Given a file spec, return target file spec if input file spec is an alias.
  95.   It resolves the entire alias chain or one step of the chain.  It returns
  96.   info about whether the target is a folder or file; and whether the input
  97.   file spec was an alias or not. 
  98. */
  99. extern pascal OSErr ResolveAliasFile(FSSpec *theSpec, Boolean resolveAliasChains, Boolean *targetIsFolder, Boolean *wasAliased)
  100.  TWOWORDINLINE(0x700C, 0xA823);
  101.  
  102. extern pascal OSErr FollowFinderAlias(ConstFSSpecPtr fromFile, AliasHandle alias, Boolean logon, FSSpec *target, Boolean *wasChanged)
  103.  TWOWORDINLINE(0x700F, 0xA823);
  104.  
  105. /*
  106.    Low Level Routines 
  107. */
  108. /* given a fromFile-target pair and an alias handle, update the lias record pointed to by alias handle to represent target as the new alias. */
  109. extern pascal OSErr UpdateAlias(ConstFSSpecPtr fromFile, const FSSpec *target, AliasHandle alias, Boolean *wasChanged)
  110.  TWOWORDINLINE(0x7006, 0xA823);
  111.  
  112. #endif
  113. #if FOR_SYSTEM7_AND_SYSTEM8_DEPRECATED
  114. typedef pascal Boolean (*AliasFilterProcPtr)(CInfoPBPtr cpbPtr, Boolean *quitFlag, Ptr myDataPtr);
  115.  
  116. #if GENERATINGCFM
  117. typedef UniversalProcPtr AliasFilterUPP;
  118. #else
  119. typedef AliasFilterProcPtr AliasFilterUPP;
  120. #endif
  121.  
  122. enum {
  123.     uppAliasFilterProcInfo = kPascalStackBased
  124.          | RESULT_SIZE(SIZE_CODE(sizeof(Boolean)))
  125.          | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(CInfoPBPtr)))
  126.          | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(Boolean *)))
  127.          | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(Ptr)))
  128. };
  129.  
  130. #if GENERATINGCFM
  131. #define NewAliasFilterProc(userRoutine)        \
  132.         (AliasFilterUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), uppAliasFilterProcInfo, GetCurrentArchitecture())
  133. #else
  134. #define NewAliasFilterProc(userRoutine)        \
  135.         ((AliasFilterUPP) (userRoutine))
  136. #endif
  137.  
  138. #if GENERATINGCFM
  139. #define CallAliasFilterProc(userRoutine, cpbPtr, quitFlag, myDataPtr)        \
  140.         CallUniversalProc((UniversalProcPtr)(userRoutine), uppAliasFilterProcInfo, (cpbPtr), (quitFlag), (myDataPtr))
  141. #else
  142. #define CallAliasFilterProc(userRoutine, cpbPtr, quitFlag, myDataPtr)        \
  143.         (*(userRoutine))((cpbPtr), (quitFlag), (myDataPtr))
  144. #endif
  145. /*  Given an alias handle and fromFile, match the alias and return aliased filename(s) and needsUpdate flag */
  146. extern pascal OSErr MatchAlias(ConstFSSpecPtr fromFile, unsigned long rulesMask, AliasHandle alias, short *aliasCount, FSSpecArrayPtr aliasList, Boolean *needsUpdate, AliasFilterUPP aliasFilter, void *yourDataPtr)
  147.  TWOWORDINLINE(0x7005, 0xA823);
  148.  
  149. #endif
  150.  
  151. #if PRAGMA_ALIGN_SUPPORTED
  152. #pragma options align=reset
  153. #endif
  154.  
  155. #if PRAGMA_IMPORT_SUPPORTED
  156. #pragma import off
  157. #endif
  158.  
  159. #ifdef __cplusplus
  160. }
  161. #endif
  162.  
  163. #endif /* __ALIASES__ */
  164.  
  165.